package com.hsqn.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration // 标识为配置类
public class SwaggerConfig {

    /**
     * 配置 API 文档基本信息
     */
    // 核心：定义 OpenAPI 实例，配置文档全局信息
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                // 1. 文档基本信息（标题、版本、描述等）
                .info(new Info()
                        .title("接口文档") // 文档标题
                        .version("1.0.0") // 接口版本
                        .description("这是基于 Spring Boot 3 + SpringDoc 的 API 文档示例") // 描述
                        .contact(new Contact() // 联系人信息
                                .name("开发团队")
                                .email("dev@example.com")
                                .url("https://example.com")));
    }
}
    